Conversation
Codacy's Analysis Summary0 new issue (≤ 0 minor issue) Review Pull Request in Codacy →
|
|
Overall readability score: 54.13 (🟢 +0.01)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Agree, but I removed the arrows instead, since it was only used in these pages but not anywhere else in the docs. |
There was a problem hiding this comment.
Pull Request Overview
The documentation changes are up to standards. They provide clear, actionable instructions for the new Custom Instructions feature, including a useful starter prompt for users. No major technical inaccuracies or broken links were found, though some minor copy-editing is suggested for better readability.
Test plan proposal
- Verify that the
codacy-reviewlabel successfully triggers the review process in a live repository. - Validate that all relative links (
../../codacy-ai/codacy-ai.md#custom-instructionsand../repositories-configure/...) resolve correctly when rendered in the documentation site. - Confirm that the path
.codacy/instructions/review.mdis the correct location expected by the AI Reviewer backend for custom instructions.
About this PR
- Consider making the PR title more specific to the feature being documented.
💡 Codacy uses AI. Check for mistakes.
|
|
||
| These instructions are specified in a `review.md` file in the `.codacy/instructions` directory of your repository. | ||
|
|
||
| You can kickstart this instructions file by asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt: |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: Minor grammatical improvement.
| You can kickstart this instructions file by asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt: | |
| You can kickstart this file by asking your AI coding agent of choice to summarize the project and the codebase. Here is an example prompt: |
|
|
||
| #### Custom Instructions | ||
|
|
||
| To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences. |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: This sentence is repetitive. This might be a simple fix:
| To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences. | |
| To improve the AI Reviewer's results, you can provide custom instructions. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| #### Custom Instructions | ||
|
|
||
| To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences. |
There was a problem hiding this comment.
The phrase "to the AI Reviewer" is redundant in this sentence. Consider rephrasing to: "To improve the results of the AI Reviewer, you can provide custom instructions. These instructions are specific to..."
| To improve the results of the AI Reviewer, you can provide custom instructions to the AI Reviewer. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences. | |
| To improve the results of the AI Reviewer, you can provide custom instructions. These instructions are specific to a repository and help the AI Reviewer understand the structure of the code, the business logic of the project, and your own preferences. |
| - If something is not applicable or not inferable, omit the section entirely. | ||
| ``` | ||
|
|
||
|
|
There was a problem hiding this comment.
Extra blank line. For consistency with the rest of the document (see lines 26-27 and 55-56), there should be only one blank line between the code block and the Notes section.
2 participants
https://codacy.atlassian.net/browse/CF-2220
👀 Live preview
https://doc-ai-instructions--docs-codacy.netlify.app/codacy-ai/codacy-ai/
https://doc-ai-instructions--docs-codacy.netlify.app/repositories-configure/integrations/github-integration/
🚧 To do